Este documento define as dimensões compatíveis com a API YouTube Reporting. Essa API recupera relatórios em massa com dados do YouTube Analytics para um proprietário de conteúdo ou canal.
As dimensões são critérios comuns usados para agregar dados, como a data em que a atividade do usuário ocorreu ou o país em que os usuários estavam localizados.
Cada relatório em massa aceita uma lista predefinida de dimensões. Em qualquer relatório, cada linha de dados tem uma combinação exclusiva de valores de dimensão. Assim, a combinação de valores de dimensão de cada linha funciona como a chave primária dela. Não é necessário especificar nem é possível especificar quais dimensões são incluídas no relatório.
Dimensões principais
Embora a API YouTube Reporting esteja sujeita à Política de descontinuação definida nos Termos de Serviço, as dimensões e métricas não principais não estão sujeitas à política. Nas definições desta página, qualquer dimensão que seja principal é identificada explicitamente como tal.
A lista a seguir identifica as dimensões principais da API. Todas elas também são dimensões principais na API YouTube Analytics.
Para mais informações, consulte a lista de APIs do YouTube sujeitas à política de descontinuação.
Dimensões
As seções a seguir definem as dimensões usadas nos relatórios em massa da API Reporting do YouTube. A menos que indicado de outra forma, essas dimensões são usadas nos relatórios de canal e de proprietário de conteúdo.
Recursos
Essas dimensões correspondem aos recursos que os canais e proprietários de conteúdo gerenciam no YouTube:
- video_id (dimensão principal)
- O ID de um vídeo do YouTube. Na API Data do YouTube, esse é o valor da propriedade
id
de um recursovideo
. This is a core dimension and is subject to the Deprecation Policy. - playlist_id
- O ID de uma playlist do YouTube. Na API Data do YouTube, esse é o valor da propriedade
id
de um recursoplaylist
. - channel_id (dimensão principal)
- O ID de um canal do YouTube. Na API Data do YouTube, esse é o valor da propriedade
id
de um recursochannel
. This is a core dimension and is subject to the Deprecation Policy. - asset_id (usado apenas em relatórios do proprietário do conteúdo)
- O ID de um recurso gerenciado no sistema do Content ID do YouTube. Um recurso é a representação da propriedade intelectual nesse sistema. No site do YouTube, você pode localizar os IDs de recursos no Gerenciador de conteúdo. Também é possível extraí-los usando a API Content ID do YouTube.
Áreas geográficas
Essas dimensões identificam uma região geográfica associada à atividade do usuário, à performance do anúncio ou às métricas de receita estimada.
- country_code (dimensão principal)
- O país associado às métricas na linha do relatório. O valor da dimensão é um código de país ISO-3166-1 de duas letras, como
US
,CN
(China) ouFR
(França). O código de paísZZ
é usado para informar métricas em que o YouTube não conseguiu identificar o país associado. This is a core dimension and is subject to the Deprecation Policy. - province_code
- O estado ou território dos EUA associado às métricas na linha do relatório. O valor da dimensão é um código ISO 3166-2 que identifica um estado dos EUA ou o Distrito de Columbia, como
US-MI
(Michigan) ouUS-TX
(Texas). O código da provínciaUS-ZZ
é usado para informar métricas em que o YouTube não conseguiu identificar o estado dos EUA associado.Observação:essa dimensão não oferece suporte a valores ISO 3166-2 que identificam áreas periféricas dos EUA, já que esses territórios também têm seus próprios códigos de país ISO 3166-1. Ele também não oferece suporte a subdivisões de países diferentes dos Estados Unidos.
Períodos
- data (dimensão principal)
- Essa dimensão identifica a data associada às métricas em cada linha do relatório. Nos relatórios em massa, a data se refere ao período que começa às 12h Horário do Pacífico e termina às 23h59 do mesmo dia, mês e ano. Dependendo da época do ano,
o horário do Pacífico é UTC-7 ou UTC-8.
Embora as datas normalmente representem um período de 24 horas, as datas em que os relógios são ajustados para o horário de verão representam um período de 23 horas, e as datas em que os relógios são ajustados para trás representam um período de 25 horas. This is a core dimension and is subject to the Deprecation Policy.
Locais de reprodução
Essas dimensões fornecem insights sobre a página ou o aplicativo em que a atividade do usuário ocorreu.
- playback_location_type
-
Essa dimensão identifica o tipo de página ou aplicativo em que a atividade do usuário ocorreu. A tabela a seguir lista os valores de dimensão:
Valores 0
Os dados se referem à atividade que ocorreu na página de exibição do vídeo no YouTube ou em um aplicativo oficial do YouTube, como o app para Android. 1
Os dados se referem a atividades que ocorreram em outro site ou aplicativo em que o vídeo foi incorporado usando um <iframe>
ou<object>
.2
Os dados se referem a atividades que ocorreram na página de um canal do YouTube. 5
Os dados se referem a métricas que não podem ser classificadas em um dos outros tipos de local listados. 7
Os dados se referem a visualizações que aconteceram na página inicial ou na tela inicial do YouTube, no feed de inscrições do usuário ou em outro recurso de navegação do YouTube. 8
Os dados se referem às visualizações que aconteceram diretamente na página de resultados da pesquisa do YouTube. 10
Os dados se referem às visualizações que aconteceram no feed dos Shorts. - playback_location_detail
- Essa dimensão especifica o URL ou aplicativo em que a reprodução ocorreu. Essa dimensão só é compatível com visualizações que ocorreram em players incorporados, o que significa que o valor da dimensão só é preenchido em linhas em que o valor da dimensão é
1
. Em outras linhas, o valor dessa dimensão está vazio.
Detalhes da reprodução
- live_or_on_demand
- Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a visualizações de uma transmissão ao vivo. Os dados dessa dimensão estão disponíveis para datas a partir de 1º de abril de 2014.
A tabela a seguir lista os valores da dimensão:
Valores live
Os dados da linha descrevem a atividade do usuário que ocorreu durante uma transmissão ao vivo. onDemand
Os dados da linha descrevem a atividade do usuário que não ocorreu durante uma transmissão ao vivo. - subscribed_status
- Essa dimensão indica se as métricas de atividade do usuário na linha de dados estão associadas a espectadores inscritos no canal do vídeo ou da playlist.
Os valores possíveis são
subscribed
eunsubscribed
.
O valor da dimensão é preciso a partir do momento em que a atividade do usuário ocorre. Por exemplo, suponha que um usuário não tenha se inscrito em um canal e assista um dos vídeos dele, depois se inscreva e assista outro vídeo, tudo no mesmo dia. O relatório do canal indica que uma visualização tem um valor desubscribed_status
desubscribed
e outra desubscribed_status
deunsubscribed
.
Origens de tráfego
- traffic_source_type
- Essa dimensão identifica o tipo de referente associado às métricas de atividade do usuário. O tipo de referência descreve a maneira como os usuários acessaram o vídeo ou canal associado à linha de dados no relatório. A tabela a seguir lista os valores de dimensão:
Valores 0
Direta ou desconhecida
Esse valor inclui o tráfego direto para uma página, bem como as páginas em que o referrer é desconhecido. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoNO_LINK_OTHER
ouUNKNOWN_MOBILE_OR_DIRECT
.1
Publicidade do YouTube
O espectador foi direcionado ao vídeo por um anúncio. Em um relatório de origem de tráfego, se o valor dessa dimensão for1
, a dimensão traffic_source_detail vai identificar o tipo de anúncio que foi mostrado ao usuário. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoADVERTISING
. Os valores possíveis são:Valores ctp_engagement_ad
Anúncio de engajamento clique para ver engagement_ad
Anúncio de engajamento googlemediaads
Anúncios da Pesquisa Google insearch_display
TrueView in-search e in-display instream
TrueView in-stream instream-select
In-stream pulável reservado unknown
Publicidade no YouTube sem classificação video_wall
Mural de vídeos yva
Anúncio em vídeo na página inicial 3
Recursos de navegação
O espectador foi redirecionado de uma página do YouTube que leva a vídeos ou canais. Em um relatório de origem de tráfego, se o valor dessa dimensão for3
, a dimensão traffic_source_detail vai identificar o recurso que indicou o tráfego. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoSUBSCRIBER
. Os valores possíveis são:Valores explore
Crianças: explorar learning
Crianças: aprendizado music
Feed de música my-history
Histórico de exibição my-subscriptions
Minhas inscrições my-uploads
Meus uploads podcasts
Página de destino do podcast shows
Crianças: programas watch-later
Assistir mais tarde what-to-watch
O que assistir 4
Canais do YouTube
Os espectadores foram redirecionados de uma página de canal do YouTube. Em um relatório de origem de tráfego, se o valor dessa dimensão for4
, a dimensão traffic_source_detail vai especificar o ID do canal. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_CHANNEL
.5
Pesquisa do YouTube
Os espectadores foram encaminhados dos resultados da pesquisa do YouTube. Em um relatório de origem de tráfego, se o valor dessa dimensão for5
, a dimensão traffic_source_detail vai especificar o termo de pesquisa associado. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_SEARCH
.7
Vídeos sugeridos
Os espectadores foram direcionados de uma lista de vídeos relacionados em outra página de exibição de vídeos. Em um relatório de origem do tráfego, se o valor dessa dimensão for7
, a dimensão traffic_source_detail vai identificar o ID do vídeo. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoRELATED_VIDEO
ouYT_RELATED
.8
Outros recursos do YouTube
Os espectadores foram redirecionados de uma página do YouTube que não se enquadra em nenhum dos outros tipos de origem de tráfego listados. Em um relatório de origem do tráfego, se o valor dessa dimensão for8
, a dimensão traffic_source_detail vai identificar o URL da página. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_OTHER_PAGE
. Os valores possíveis são:Valores g-crec
Canais recomendados offline
Off-line promotion
Promoção de parceiros unknown
Desconhecido widget
Widget da tela inicial do Android youtu.be
youtu.be ytremote
YouTube Remoto 9
Externo
Os espectadores foram redirecionados por um link em outro site. Essa origem de tráfego inclui referências dos resultados da Pesquisa Google. Em um relatório de origem do tráfego, se o valor dessa dimensão for9
, a dimensão traffic_source_detail vai identificar a página da Web externa. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoEXT_URL
.11
Anotações e cards de vídeo
Os espectadores foram redirecionados ao clicar em uma anotação ou um card em outro vídeo. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoANNOTATION
.14
Playlists
As visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist. Nos relatórios de consulta, esse tipo de origem do tráfego é identificado comoPLAYLIST
.
Essa origem do tráfego é diferente do tipo18
, que indica que as visualizações foram originadas da página que lista todos os vídeos da playlist.17
Notificações
Os espectadores foram direcionados por um e-mail ou notificação do YouTube. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoNOTIFICATION
. Os valores possíveis são:Valores inbox
push
sdig
Visualizações originadas de notificações que faziam parte do resumo do inscrito uploaded_other
Visualizações originadas de notificações não push, como e-mails ou notificações da caixa de entrada, enviadas aos inscritos quando um vídeo foi enviado uploaded_push
Visualizações originadas de notificações push enviadas aos inscritos quando um vídeo foi enviado 18
Páginas de playlist
Visualizações originadas de uma página que lista todos os vídeos de uma playlist. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoYT_PLAYLIST_PAGE
.
Esse tipo de origem de tráfego é diferente do tipo14
, que indica que as visualizações ocorreram enquanto o vídeo era reproduzido como parte de uma playlist.19
Programação de conteúdo reivindicado
Visualizações originadas de vídeos reivindicados enviados por usuários que o proprietário do conteúdo usou para promover o conteúdo visualizado. Nos relatórios de consulta, essa origem de tráfego é identificada comoCAMPAIGN_CARD
. Essa origem de tráfego só tem suporte para relatórios de proprietários de conteúdo.20
Tela final interativa do vídeo
Visualizações originadas da tela final de outro vídeo. Nos relatórios de consulta, esse tipo de origem de tráfego é identificado comoEND_SCREEN
.23
Histórias
O espectador foi encaminhado deslizando verticalmente do vídeo anterior na experiência de visualização das Histórias.24
Shorts
O espectador foi redirecionado deslizando verticalmente do vídeo anterior na experiência de visualização dos Shorts.25
Páginas de produtos
Os vídeos em uma página de produto levaram os espectadores a outro canal.26
Páginas de hashtag
: visualizações originadas de páginas de hashtag de VOD ou de Shorts.27
Páginas de música
Visualizações originadas das páginas temáticas de áudio dos Shorts.28
Redirecionamento em tempo real
Visualizações originadas de Redirecionamentos em tempo real.29
Podcasts
Visualizações originadas da página YouTube Podcasts.30
Vídeo remixado
Visualizações originadas de um link de vídeo remixado no player dos Shorts.31
Feed vertical ao vivo
Visualizações originadas do feed vertical ao vivo.32
Vídeo relacionado
Visualizações originadas de um link de vídeo relacionado no player dos Shorts. - traffic_source_detail
- Essa dimensão fornece mais detalhes sobre a origem do tráfego que o valor da dimensão traffic_source_type da linha. Esse valor é preenchido para os seguintes valores de dimensão traffic_source_type:
1
: o valor da dimensão identifica o tipo de anúncio que foi mostrado ao usuário. Consulte a definição de traffic_source_type para conferir uma lista de valores possíveis.3
: o valor da dimensão identifica o recurso do YouTube que gerou o tráfego referido. Consulte a definição de traffic_source_type para conferir uma lista de valores possíveis.4
: o valor da dimensão especifica o ID do canal de onde o espectador foi encaminhado.5
: o valor da dimensão especifica o termo de pesquisa que levou ao tráfego referido.7
: o valor da dimensão identifica o vídeo de origem da referência.8
: o valor da dimensão identifica o tipo de página do YouTube que levou ao tráfego referido. Consulte a definição de traffic_source_type para conferir uma lista de valores possíveis.9
: o valor da dimensão identifica a página externa de onde o tráfego foi encaminhado.17
: o valor da dimensão identifica o tipo de notificação que levou ao tráfego referido. Consulte a definição de traffic_source_type para conferir uma lista de valores possíveis.19
: o valor da dimensão identifica o vídeo de origem da referência.20
: o valor da dimensão identifica o vídeo de origem da referência.25
: o valor da dimensão identifica o ID do produto, que é um ID do Mapa de informações do Google.26
: o valor da dimensão identifica a hashtag que levou ao tráfego referido.27
: o valor da dimensão identifica o vídeo de origem da referência.28
: o valor da dimensão especifica o ID do canal de onde o espectador foi redirecionado por Redirecionamentos em tempo real.30
: o valor da dimensão especifica o vídeo de origem da referência do espectador.
Dispositivos
- device_type
- Essa dimensão identifica o formato físico do dispositivo em que a visualização ocorreu.
A tabela a seguir lista os valores de dimensão válidos:
Valores 100
Desconhecido 101
Computador 102
TV 103
Console de jogos 104
Dispositivo móvel 105
Tablet - operating_system
- Essa dimensão identifica o sistema de software do dispositivo em que a visualização ocorreu.
A tabela a seguir lista os valores de dimensão válidos:
Valores 1
Outro 2
Windows 3
Windows Mobile 4
Android 5
iOS 6
Symbian 7
Blackberry 9
Macintosh 10
Playstation 11
Bada 12
WebOS 13
Linux 14
Hiptop 15
MeeGo 16
Wii 17
Xbox 18
PlayStation Vita 19
Smart TV 20
Nintendo 3DS 21
Chromecast 22
Tizen 23
Firefox 24
RealMedia 25
KaiOS 26
Roku 27
Nintendo Switch 28
Apple tvOS 29
Fire OS 30
ChromeOS 31
Vidaa
Informações demográficas
As dimensões demográficas ajudam a entender a faixa etária e a distribuição de gênero do seu público. A Central de Ajuda do YouTube tem mais informações sobre dados demográficos nos relatórios YouTube Analytics.
- age_group (dimensão principal)
- Essa dimensão identifica o grupo de idade dos usuários conectados associados aos dados do relatório. A API usa as seguintes faixas etárias:
AGE_13_17
AGE_18_24
AGE_25_34
AGE_35_44
AGE_45_54
AGE_55_64
AGE_65_
- gênero (dimensão principal)
- Essa dimensão identifica o gênero dos usuários conectados associados aos dados do relatório.
Os valores válidos são
FEMALE
,MALE
eGENDER_OTHER
. This is a core dimension and is subject to the Deprecation Policy.
Engajamento e compartilhamento de conteúdo
- sharing_service (dimensão principal)
- Essa dimensão identifica o serviço usado para compartilhar vídeos. Os vídeos podem ser compartilhados no YouTube (ou pelo player do YouTube), utilizando o botão "Compartilhar". This is a core dimension and is subject to the Deprecation Policy.
A tabela a seguir lista os valores de dimensão válidos:
Valores 0
Desconhecido 1
Digg 4
reddit 5
StumbleUpon 6
mixi 7
Yahoo! Japan 8
goo 9
Ameba 10
Facebook 11
Myspace 12
NUjij 18
Tuenti 20
menéame 21
Wykop 22
Skyrock 25
Fotka 28
hi5 31
Twitter 32
Cyworld 34
Blogger 36
VKontakte (ВКонтакте) 37
Rakuten (楽天市場) 38
LiveJournal 39
Odnoklassniki (Одноклассники) 40
Tumblr. 42
LinkedIn 43
Google+ 44
Weibo 45
Pinterest 46
E-mail 47
Facebook Messenger 49
WhatsApp 50
Hangouts 51
Gmail 52
Kakao (Kakao Talk) 53
Outro 55
Copiar para a área de transferência 59
Incorporar 60
Mensagem de texto 61
Mensagens do Android 62
Mensagens da Verizon 63
Mensagem de texto da HTC 64
Sony Conversations 65
Go SMS 66
E-mail da LGE 67
Linha 68
Viber 69
Kik 70
Skype 71
BlackBerry Messenger 72
WeChat 73
KAKAO Story 74
Dropbox 75
Telegram 76
Páginas do Facebook 77
GroupMe 78
Android Email 79
Motorola Messaging 80
Compartilhar por proximidade 81
Naver 82
Caixa de diálogo de atividade do sistema iOS 83
Caixa de entrada do Google 84
Android Messenger 85
YouTube Music 86
YouTube Gaming 87
YouTube Kids 88
YouTube TV
Consulte os documentos de ajuda para mais informações.
Anotações
- annotation_type
- Essa dimensão identifica a maneira como a anotação aparece durante o vídeo. A tabela a seguir lista os possíveis valores de dimensão:
Valores 0
Desconhecido 1
Observação 3
Destaque 4
Título 8
Balão de diálogo 9
Rótulo 10
Marca-d'água de branding 11
Vídeo em destaque 12
Playlist em destaque 30
o que fazer agora - annotation_id
- O ID que o YouTube usa para identificar exclusivamente uma anotação.
Cartões
- card_type
- Essa dimensão identifica o tipo de card que foi mostrado ao usuário. A tabela a seguir lista os possíveis valores de dimensão:
Valores 0
Desconhecido 60
Link 61
Arrecadação de fundos 62
Vídeo 63
Playlist 65
Financiamento por fãs 66
Produtos 68
Site associado 69
Canal - card_id
- O ID que o YouTube usa para identificar um card de forma exclusiva.
Telas finais
- end_screen_element_type
- Essa dimensão identifica o tipo de elemento da tela final que foi mostrado ao usuário. A tabela a seguir lista os tipos de elementos da tela final e os valores deles:
Valores 501
Vídeo: o elemento promove outro vídeo do YouTube. 502
Playlist: o elemento promove a playlist do YouTube. 503
Site: o elemento é vinculado ao site associado. 504
Canal: o elemento é vinculado a outro canal. 505
Inscrever-se: o elemento incentiva as inscrições no seu canal. 506
Associado 507
Crowdfunding: o elemento tem um link para um site de financiamento coletivo aprovado. 508
Produtos: o elemento vincula a um site de produtos aprovado. 509
Envio recente: o elemento é vinculado ao vídeo mais recente enviado no seu canal. 510
O melhor para o espectador - end_screen_element_id
- O ID que o YouTube usa para identificar exclusivamente um elemento da tela final.
Legendas
- subtitle_language
- Essa dimensão identifica o idioma da legenda usada por mais tempo durante a visualização. As visualizações em que as legendas descritivas foram desativadas não são contabilizadas. Consulte a documentação dos relatórios de canal ou de proprietários de conteúdo para mais informações sobre os relatórios que contêm essa dimensão.
- subtitle_language_autotranslated
- Essa dimensão identifica o idioma das legendas traduzidas automaticamente usado por mais tempo durante a visualização. As visualizações em que as legendas descritivas foram desativadas não são contabilizadas. Consulte a documentação dos relatórios de canal ou de proprietários de conteúdo para mais informações sobre os relatórios que contêm essa dimensão.
Desempenho do anúncio
- ad_type
- A dimensão
ad_type
é usada nos relatórios de performance de anúncios e agrega as métricas solicitadas com base nos tipos de anúncios veiculados durante a reprodução de vídeo. A tabela a seguir lista os valores de dimensão possíveis. Consulte a Central de Ajuda do YouTube para mais informações sobre os formatos de publicidade do YouTube.
Valor Descrição Valor nos relatórios de consulta 1
Anúncios em vídeo puláveis (leilão) auctionTrueviewInstream
2
Anúncios de display (leilão) auctionDisplay
3
Anúncios em vídeo não puláveis (leilão) auctionInstream
5
Anúncios de display (reservado) reservedDisplay
6
Anúncios em vídeo não puláveis (reservado) reservedInstream
13
Desconhecido unknown
15
Anúncios em vídeo puláveis (reservado) reservedInstreamSelect
19
Anúncios bumper (leilão) auctionBumperInstream
20
Anúncios bumper (reservado) reservedBumperInstream
Observação:os relatórios de consulta podem retornar alguns outros tipos de anúncios que foram usados anteriormente no YouTube.
Dimensões do proprietário do conteúdo
As dimensões a seguir são usadas apenas nos relatórios de proprietários de conteúdo.
- claimed_status (usado apenas em relatórios do proprietário do conteúdo)
- Essa dimensão indica que uma linha de dados contém apenas métricas para conteúdo reivindicado. O único valor válido para essa dimensão é
claimed
. A tabela na definição da dimensãouploader_type
fornece mais detalhes sobre como usar essa dimensão.
- uploader_type (dimensão principal) (usado apenas em relatórios de proprietários de conteúdo)
- Essa dimensão indica se uma linha de dados contém métricas de conteúdo enviado pelo proprietário especificado e/ou conteúdo enviado por terceiros, como vídeos enviados por usuários. Os valores válidos são
self
ethirdParty
. Essa é uma dimensão principal e está sujeita à política de descontinuação.
A tabela abaixo mostra as combinações compatíveis para as dimensõesclaimed_status
euploader_type
:
Valor de claimed_status
Valor de uploader_type
Descrição [Não definido] self A linha contém dados do YouTube Analytics para conteúdo reivindicado e não reivindicado enviado pelo proprietário. reivindicados self A linha contém dados do conteúdo reivindicado enviado pelo proprietário. reivindicados thirdParty A linha contém dados de conteúdo reivindicado enviado por terceiros.